Documentação - Documentação

post https://gateway.iugu.com/api/v1/transactions/capture/{payment_id}

Capturar um pagamento autorizado

Captura fundos de um pagamento previamente autorizado

Permissão necessária: gateway:transactions.capture

Esta permissão deve constar como uma das ações permitidas para o app que faz a chamada. Isto pode ser feito através do GIA, ou então na edição do aplicativo. Em caso de dúvidas, clique aqui.

Request

Path variables
payment_id Required Type: string ID do pagamento a ser capturado

Body Required

Content Type: application/json

amount_cents

Integer

Valor a ser capturado em centavos. Se não informado, será capturado o valor total da autorização.

Example

1
2
3
{
  "amount_cents": 10000
}

Response

200

Pagamento capturado com sucesso

payment

Object

String

account_id

String

order_id

String

amount_cents

Integer

status

String

created_at

String

transactions

Array of objects

success

Boolean

function

String
Enum: `authorization`, `charge`, `capture`, `cancel`

acquirer

Object

status_code

String

status_description

String

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
  "payment": {
    "id": "<ID>",
    "account_id": "<ACCOUNT_ID>",
    "order_id": "<ORDER_ID>",
    "amount_cents": "<AMOUNT_CENTS>",
    "status": "<STATUS>",
    "created_at": "<CREATED_AT>",
    "transactions": [
      {
        "success": "<SUCCESS>",
        "function": "<FUNCTION>",
        "acquirer": {
          "status_code": "<STATUS_CODE>",
          "status_description": "<STATUS_DESCRIPTION>"
        }
      }
    ]
  }
}

401
Não autorizado - Token de autenticação inválido ou ausente

404
Pagamento não encontrado

422
Erros de validação ou captura falhou

Back

Autorizar um pagamento com cartão de crédito

Forward

Autorizar e capturar em uma única requisição